Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add queue passName #17309

Merged
merged 4 commits into from
Jul 5, 2024
Merged

add queue passName #17309

merged 4 commits into from
Jul 5, 2024

Conversation

star-e
Copy link
Contributor

@star-e star-e commented Jul 5, 2024

Add pass name override to the queue.

Changelog


Continuous Integration

This pull request:

  • needs automatic test cases check.

    Manual trigger with @cocos-robot run test cases afterward.

  • does not change any runtime related code or build configuration

    If any reviewer thinks the CI checks are needed, please uncheck this option, then close and reopen the issue.


Compatibility Check

This pull request:

  • changes public API, and have ensured backward compatibility with deprecated features.
  • affects platform compatibility, e.g. system version, browser version, platform sdk version, platform toolchain, language version, hardware compatibility etc.
  • affects file structure of the build package or build configuration which requires user project upgrade.
  • introduces breaking changes, please list all changes, affected features and the scope of violation.

@star-e
Copy link
Contributor Author

star-e commented Jul 5, 2024

@cocos-robot run test cases

Copy link

github-actions bot commented Jul 5, 2024

Interface Check Report

! WARNING this pull request has changed these public interfaces:

@@ -36419,11 +36419,12 @@
              * 每个队列有一个相位(phase)名字,具有相同相位名字的物件才会被渲染。
              *
              * @param hint @en Usage hint of the queue @zh 用途的提示
              * @param phaseName @en The name of the phase declared in the effect. Default value is 'default' @zh effect中相位(phase)的名字,缺省为'default'。
+             * @param passName @en The name of the pass declared in the effect. It is used to override the pass name in the parent pass/subpass. @zh effect中通道(pass)的名字,会覆盖(override)父(通道/子通道)中已设置的pass名字。
              * @returns @en render queue builder @zh 渲染队列
              */
-            addQueue(hint?: QueueHint, phaseName?: string): RenderQueueBuilder;
+            addQueue(hint?: QueueHint, phaseName?: string, passName?: string): RenderQueueBuilder;
             /**
              * @en Set rendering viewport.
              * @zh 设置渲染视口
              * @param viewport @en The required viewport @zh 所需视口
@@ -36792,11 +36793,12 @@
              * 每个队列有一个相位(phase)名字,具有相同相位名字的物件才会被渲染。
              *
              * @param hint @en Usage hint of the queue @zh 用途的提示
              * @param phaseName @en The name of the phase declared in the effect. Default value is 'default' @zh effect中相位(phase)的名字,缺省为'default'。
+             * @param passName @en The name of the pass declared in the effect. It is used to override the pass name in the parent pass/subpass. @zh effect中通道(pass)的名字,会覆盖(override)父(通道/子通道)中已设置的pass名字。
              * @returns @en render queue builder @zh 渲染队列
              */
-            addQueue(hint?: QueueHint, phaseName?: string): RenderQueueBuilder;
+            addQueue(hint?: QueueHint, phaseName?: string, passName?: string): RenderQueueBuilder;
             /**
              * @en Show statistics on screen
              * @zh 在屏幕上渲染统计数据
              */
@@ -36908,11 +36910,12 @@
              * 每个队列有一个相位(phase)名字,具有相同相位名字的物件才会被渲染。
              *
              * @param hint @en Usage hint of the queue @zh 用途的提示
              * @param phaseName @en The name of the phase declared in the effect. Default value is 'default' @zh effect中相位(phase)的名字,缺省为'default'。
+             * @param passName @en The name of the pass declared in the effect. It is used to override the pass name in the parent pass/subpass. @zh effect中通道(pass)的名字,会覆盖(override)父(通道/子通道)中已设置的pass名字。
              * @returns @en compute queue builder @zh 计算队列
              */
-            addQueue(phaseName?: string): ComputeQueueBuilder;
+            addQueue(phaseName?: string, passName?: string): ComputeQueueBuilder;
             /**
              * @experimental
              */
             setCustomShaderStages(name: string, stageFlags: gfx.ShaderStageFlagBit): void;
@@ -37058,11 +37061,12 @@
              * 每个队列有一个相位(phase)名字,具有相同相位名字的物件才会被渲染。
              *
              * @param hint @en Usage hint of the queue @zh 用途的提示
              * @param phaseName @en The name of the phase declared in the effect. Default value is 'default' @zh effect中相位(phase)的名字,缺省为'default'。
+             * @param passName @en The name of the pass declared in the effect. It is used to override the pass name in the parent pass/subpass. @zh effect中通道(pass)的名字,会覆盖(override)父(通道/子通道)中已设置的pass名字。
              * @returns @en compute queue builder @zh 计算队列
              */
-            addQueue(phaseName?: string): ComputeQueueBuilder;
+            addQueue(phaseName?: string, passName?: string): ComputeQueueBuilder;
             /**
              * @experimental
              */
             setCustomShaderStages(name: string, stageFlags: gfx.ShaderStageFlagBit): void;

@star-e star-e requested a review from minggo July 5, 2024 08:41
@star-e star-e merged commit e155348 into cocos:v3.8.5 Jul 5, 2024
22 of 23 checks passed
@star-e star-e deleted the v3.8.5-pipeline branch July 29, 2024 09:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants